home *** CD-ROM | disk | FTP | other *** search
/ Educational Software Cooperative 4 / Educational Software Cooperative 4.iso / mxdb / mxreadme.use < prev    next >
Encoding:
Text File  |  1995-12-05  |  3.0 KB  |  76 lines
  1. LEFT MARGIN=5
  2.              ----MX README DOCUMENTATION, version 1.0----
  3.  
  4.  
  5. This freeware version of README requires file MXDB.DOC and MXREADME.USE
  6. be distributed with it.
  7.  
  8. This MXREADME program is intended for software authors.  It makes an
  9. easy access library for your text files.  With it your users will not
  10. have to fish around for important information.
  11.  
  12. The program looks for file MXREADME.LST when it starts.  This file must
  13. be in the same directory as README.EXE.
  14.  
  15. File MXREADME.LST configures the program and identifies the files to be
  16. included in the library.
  17.  
  18. The MXREADME.LST file starts with a block of information that
  19. looks something like this;
  20.  
  21. [PROGRAM SETTINGS]
  22. DELIMITER=|
  23. APPLICATION=CD-ROM|?:/FRONT/JCSD.EXE
  24. LEFT MARGIN=1
  25.  
  26. Any application program can be launched directly from MXREADME.
  27. "APPLICATION=" determines what program will be offered.  The format is
  28. TITLE + DELIMITER + PATH + EXE.
  29.  
  30. In the above example the text following "APPLICATION=" is
  31. used as;
  32.  
  33. "CD-ROM" Appears as menu item "RUN CD-ROM" while viewing a text file.
  34.  
  35. "?:\FRONT\JCSD.EXE" When menu item Run CD-ROM is selected the program
  36. will switch to path ?:\FRONT and execute JCSD.EXE.  The first character
  37. of the path will always be replaced with the drive letter where file
  38. README.EXE resides.  If no application is given then the menu item
  39. RUN will not appear.
  40.  
  41. The DELIMITER is set by the preceding line called DELIMITER=.  This
  42. separates the menu text from the path + EXE. Use the _ character to
  43. represent starting or ending blank spaces.  A semi-colon plus blank
  44. space delimiter would be entered as ( ;_), without the parenthesis.
  45.  
  46. LEFT MARGIN determines position of the text on screen.  Use 1 if your
  47. files tend to be close to 80 columns wide.  If you set this to greater
  48. than 1 and your text file contains a line wider than will fit, the
  49. program will automatically switch to 80 columns.  The left margin for
  50. individual files can be set by adding LEFT MARGIN=5 as the first text in
  51. each text file.  This MXREADME.USE file does this.
  52.  
  53. The [FILES] block lists text files for the library.  A file list might
  54. look something like this.
  55.  
  56. [FILES]
  57. README.1ST    Start-up screen
  58. DOCU.TXT      Documentation
  59. COMPANY.TXT   About our company
  60. MXDB.DOC      About the MX Shareware database
  61. MXREADME.USE  About this README program
  62.  
  63. The filename block must contain MXDB.DOC and MXREADME.USE.  Each
  64. filename may be followed by a brief description.  A path may precede the
  65. filenames.  The drive letter on any path will be striped off and
  66. replaced with the current one.  Therefore, paths can be entered as
  67. ?:\YOURPATH.
  68.  
  69. README.EXE can also service documentation needs by launching from
  70. inside an application using RUN = README + PATH.  PATH is passed
  71. as a command line argument.  When README see this argument it will
  72. offer to return to this path upon terminating and execute what
  73. ever program is given by the APPLICATION= setting.  Do not provide a
  74. path in the APPLICATION= setting if this is to be done.
  75.  
  76.